feat: add streaming payments tutorial #2

michielbdejong · 2017-09-26T13:56:38Z

No description provided.

michielbdejong · 2017-09-27T10:09:41Z

Updated for IL-RFC-4, draft 6.

michielbdejong · 2017-09-28T16:30:34Z

@emschwartz @adrianhopebailie bump

adrianhopebailie

I haven't got the time to review the JS in detail but the concept LGTM

emschwartz · 2017-09-28T17:01:08Z

streaming-payments.md

+
+## What you'll learn:
+
+* convert the proxy from the Letter Shop tutorial into a payment tool


What do you mean by "payment tool"?

emschwartz · 2017-09-28T17:01:36Z

streaming-payments.md

+* using the ILP packet
+* streaming payments
+* how to use trustlines to speed things up
+* Bilateral Transfer Protocol (BTP) and its relation to ILP


That is a lot to include in one tutorial

emschwartz · 2017-09-28T17:03:01Z

streaming-payments.md

+    res._headerSent = true
+  }).listen(8000)
+})
+```


I think small code samples next to explanations of what's going on are more helpful than this kind of large code block. If someone wants to see the whole thing at once they should just go to the included source file

emschwartz · 2017-09-28T17:04:10Z

streaming-payments.md

+
+## The Pay Header
+
+We'll change the Letter Shop from the previous tutorial a bit, to `shop2.js`:


Might be worth a small mention of what we're trying to change this to do

emschwartz · 2017-09-28T17:05:07Z

streaming-payments.md

+    const parts = ilpPacketContents.account.split('.')
+    // 0: test, 1: crypto, 2: xrp, 3: rrhnXcox5bEmZfJCHzPxajUtwdt772zrCW, 4: userId, 5: paymentId
+    if (parts.length < 6 || typeof users[parts[4]] === 'undefined' || ilpPacketContents.amount !== transfer.amount) {
+      plugin.rejectIncomingTransfer(transfer.id, {}).catch(function () {})


Seems like a bit of a janky way to deal with the ilp address. Also, if you're rejecting the transfer it would be better to put some kind of message as to why

janky way to deal with the ilp address

You mean appending the userId to the destination address? Isn't this what SPSP does as well, with the receiver id and token?

emschwartz · 2017-09-28T17:47:48Z

streaming-payments.md

+node ./shop3.js
+```
+
+And here is the content consumption tool, which first transfers 1000 XRP to its account at the shop's ledger, and then


I think someone might reasonably be confused about why it's better to transfer all the money to the shop before they send you anything than to do it in exchange for the letters. I think BTP makes more sense when you're funding an account with a connector that you'll use for a lot of payments to different receivers.

Ah, actually that text is incorrect, that's what I wanted to do first, but I ended up just sending the drops from a setInterval. But that's still putting a lot of trust in the shop; I could change the code so that it counts how many letters were received, and limits the in-flight amount (e.g. if the shop is behind by more than 10 letters, throttle the money sending)

emschwartz · 2017-09-28T17:51:24Z

streaming-payments.md

+consumes 1000 letters. Save it as `tool2.js`:
+```js
+const IlpPacket = require('ilp-packet')
+const Plugin = require('ilp-plugin-payment-channel-framework')


I think it would be more impressive to show how the sender switching to BTP makes their payments faster without the receiver having to change anything (or vice versa)

yes, but for that we need to connect to Amundsen - I was saving that for the third tutorial. This is still just a one-transfer payment, so shop and customer still need to be on the same ledger.

emschwartz · 2017-09-28T17:51:46Z

streaming-payments.md

+  inRes.body.pipe(process.stdout)
+  const payHeaderParts = inRes.headers.get('Pay').split(' ')
+  console.log(payHeaderParts)
+  // e.g. Pay: 1 test.crypto.xrp.asdfaqefq3f.26wrgevaew SkTcFTZCBKgP6A6QOUVcwWCCgYIP4rJPHlIzreavHdU


Should be a different address now

emschwartz · 2017-09-28T17:53:06Z

streaming-payments.md

+We used the ILP packet for the first time, talked about connectors, payments as chains of transfers, and used
+the `Pay` header, so that the shop could request payment from the tool that connects to it.
+
+We added a BTP-enabled ledger to the shop, so that our content consumption tool can receive letters faster.


I think this is too much to introduce in one tutorial. I think it would be better to separate trustlines/BTP from the Pay header

emschwartz · 2017-09-28T17:54:32Z

shop3.js

+  _store: {
+    get: (k) => store[k],
+    put: (k, v) => { store[k] = v },
+    del: (k) => delete store[k]


Might be worth noting in a comment that it wouldn't be a good idea to use an in-memory store like this in practice but this is just for the example

michielbdejong · 2017-10-24T17:28:00Z

Even though @emschwartz did a previous review of this PR, requested review from @sharafian this time, because 1) he worked on http-ilp, and 2) he is working on developer onboarding.

comments addressed (except maybe #2 (comment) as the section that describes BTP is still a bit dense; will continue working on that with Ben)

sharafian

LGTM as a first version; I'll submit a PR to update to our latest tools

michielbdejong · 2017-10-25T06:39:20Z

OK, merging this so we can improve it further

* feat: add streaming payments tutorial * use psk * use psk * update streaming payments tutorial * list trustlines tutorial * fix: improve paragraph about BTP symmetry

michielbdejong requested review from adrianhopebailie and emschwartz September 26, 2017 13:56

This was referenced Sep 26, 2017

Initial version of a spec providing ILP payments for HTTP calls interledger/rfcs#149

Closed

letter shop tutorial #1

Merged

michielbdejong force-pushed the mj-streaming-payments branch from dcde0af to 5f4b4e2 Compare September 27, 2017 10:09

michielbdejong force-pushed the mj-streaming-payments branch from 5f4b4e2 to 0c08c6d Compare September 27, 2017 15:04

michielbdejong mentioned this pull request Sep 28, 2017

Ideas for improving HTTP-ILP interledger/rfcs#307

Closed

adrianhopebailie approved these changes Sep 28, 2017

View reviewed changes

emschwartz previously requested changes Sep 28, 2017

View reviewed changes

This was referenced Sep 29, 2017

Proposal for tutorial order #3

Closed

Tutorial 2 feedback interledger-deprecated/interledger#1

Open

michielbdejong mentioned this pull request Oct 6, 2017

Updated HTTP-ILP (Continuation of #149) interledger/rfcs#306

Merged

michielbdejong force-pushed the mj-streaming-payments branch from bb716b8 to 4d06a8c Compare October 23, 2017 12:02

michielbdejong changed the base branch from mj-letter-shop to master October 23, 2017 12:05

feat: add streaming payments tutorial

5ef84cf

michielbdejong force-pushed the mj-streaming-payments branch from 2cc3856 to 5ef84cf Compare October 24, 2017 14:57

michielbdejong changed the base branch from master to mj-letter-shop-fixes October 24, 2017 14:57

Michiel de Jong added 4 commits October 24, 2017 19:02

use psk

c41c1d1

use psk

7a8032d

update streaming payments tutorial

c074bfd

list trustlines tutorial

27bac76

michielbdejong requested a review from sharafian October 24, 2017 17:26

sharafian approved these changes Oct 24, 2017

View reviewed changes

fix: improve paragraph about BTP symmetry

a71bdab

michielbdejong merged commit 7d1fca4 into mj-letter-shop-fixes Oct 25, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add streaming payments tutorial #2

feat: add streaming payments tutorial #2

michielbdejong commented Sep 26, 2017

michielbdejong commented Sep 27, 2017

michielbdejong commented Sep 28, 2017 •

edited

Loading

adrianhopebailie left a comment

emschwartz Sep 28, 2017

emschwartz Sep 28, 2017

emschwartz Sep 28, 2017

emschwartz Sep 28, 2017

emschwartz Sep 28, 2017

michielbdejong Sep 29, 2017

emschwartz Sep 28, 2017

michielbdejong Sep 29, 2017 •

edited

Loading

emschwartz Sep 28, 2017

michielbdejong Sep 29, 2017

emschwartz Sep 28, 2017

emschwartz Sep 28, 2017

emschwartz Sep 28, 2017

michielbdejong commented Oct 24, 2017

sharafian left a comment

michielbdejong commented Oct 25, 2017


		## What you'll learn:

		* convert the proxy from the Letter Shop tutorial into a payment tool


		## The Pay Header

		We'll change the Letter Shop from the previous tutorial a bit, to `shop2.js`:

feat: add streaming payments tutorial #2

feat: add streaming payments tutorial #2

Conversation

michielbdejong commented Sep 26, 2017

michielbdejong commented Sep 27, 2017

michielbdejong commented Sep 28, 2017 • edited Loading

adrianhopebailie left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michielbdejong Sep 29, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michielbdejong commented Oct 24, 2017

sharafian left a comment

Choose a reason for hiding this comment

michielbdejong commented Oct 25, 2017

michielbdejong commented Sep 28, 2017 •

edited

Loading

michielbdejong Sep 29, 2017 •

edited

Loading